Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documented the RestartableJenkinsRule #7754

Merged

Conversation

StefanSpieker
Copy link
Contributor

Documented the RestartableJenkinsRule also created a very small example to showcase how it can be used.

@StefanSpieker StefanSpieker requested a review from a team as a code owner December 15, 2024 10:25
@probot-autolabeler probot-autolabeler bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Dec 15, 2024
Copy link
Member

@krisstern krisstern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @StefanSpieker for the PR! I have made some minor edit suggestions.

content/doc/developer/testing/index.adoc Outdated Show resolved Hide resolved
content/doc/developer/testing/index.adoc Outdated Show resolved Hide resolved
content/doc/developer/testing/index.adoc Outdated Show resolved Hide resolved
content/doc/developer/testing/index.adoc Outdated Show resolved Hide resolved
content/doc/developer/testing/index.adoc Outdated Show resolved Hide resolved
@StefanSpieker
Copy link
Contributor Author

Thanks for the suggestions, @krisstern !

Copy link
Member

@krisstern krisstern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I like the documentation, but think that the heading should be changed from "Testing Durable Pipeline Steps" to "Testing Jenkins Restart", since the example is showing a test with a FreeStyleProject rather than a Pipeline step.

I don't think we should use RestartableJenkinsRule to test Pipeline steps because the workflow-durable-task-step plugin is no longer using RestartableJenkinsRule. It migrated from RestartableJenkinsRule to JenkinsSessionRule in this pull request:

It added RealJenkinsRule based tests in these pull requests:

I think that documenting RestartableJenkinsRule is great. Thanks for doing it!

content/doc/developer/testing/index.adoc Outdated Show resolved Hide resolved
@StefanSpieker
Copy link
Contributor Author

Thanks @MarkEWaite! You are right, since I just kept the existing headline, it does not really make sense. I will add some documentation for the JenkinsSessionRule in another PR. I'm trying to get the WIP of this testing done :)

Copy link
Contributor

@MarkEWaite MarkEWaite left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@MarkEWaite MarkEWaite merged commit 53a3cc8 into jenkins-infra:master Dec 16, 2024
5 of 6 checks passed
@StefanSpieker StefanSpieker deleted the restartable_jenkins_rule branch December 16, 2024 16:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Jenkins documentation, including user and developer docs, solution pages, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants